Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add open source resources for docs #45

Merged
merged 10 commits into from
Apr 18, 2024
Merged

Add open source resources for docs #45

merged 10 commits into from
Apr 18, 2024

Conversation

mj850
Copy link
Collaborator

@mj850 mj850 commented Apr 17, 2024

Update README and Styleguide to encourage open source contributions

Add Github workflow to gate merging on validation (just simply building)

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-45.d6a0j0qs0ri14.amplifyapp.com

Copy link
Contributor

@besated besated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! left a couple comments

@@ -1,23 +1,48 @@
# Nextra Docs Template
## Quick Start
Ensure you have `yarn` installed (macOS users can Run `brew install yarn`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the docs actually uses pnpm instead of yarn, can you update this?

also we'll need to update the github workflow above

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! I've been using yarn the whole time

Just updated with instructions for pnpm

For more information on how the docs are structured, please refer to the [Nextra docs](https://nextra.site/docs/guide).

### Changing Content
All content submitted will be reviewed by a maintainer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can u make sure that each PR requires at least one maintainer to review

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a CODEOWNERS file to specify this, but will probably only take effect when it's merged into main

@mj850 mj850 requested a review from besated April 17, 2024 20:09
Copy link
Contributor

@besated besated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

per discussion, let's just stick with yarn instead otherwise looks good!

@mj850 mj850 merged commit 1d3d520 into main Apr 18, 2024
2 checks passed
mj850 added a commit that referenced this pull request Apr 18, 2024
* style guide

* workflow

* test remove push

* build

* use pnpm instead

* pnpm setup

* version

* add codeowners file

* revert to yarn

* edit link
mj850 added a commit that referenced this pull request Apr 19, 2024
* style guide

* workflow

* test remove push

* build

* use pnpm instead

* pnpm setup

* version

* add codeowners file

* revert to yarn

* edit link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants